/*
 * The contents of this web application are subject to the Mozilla Public License Version 
 * 1.1 (the "License"); you may not use this web application except in compliance with 
 * the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, 
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
 * for the specific language governing rights and limitations under the License.
 * 
 * The Original Code is owned by and the Initial Developer of the Original Code is 
 * Composite A/S (Danish business reg.no. 21744409). All Rights Reserved
 * 
 * Section 11 of the License is EXPRESSLY amended to include a provision stating 
 * that any dispute, including but not limited to disputes related to the enforcement 
 * of the License, to which Composite A/S as owner of the Original Code, as Initial 
 * Developer or in any other role, becomes a part to shall be governed by Danish law 
 * and be initiated before the Copenhagen City Court ("K�benhavns Byret")            
 */

using System.Xml.Linq;
using Composite.Core.ResourceSystem;

namespace Composite.Tools.PackageCreator.Types
{
    /// <summary>
    /// Represents an item from a package creator configuration.
    /// Can be either deserialized from package configuration or created for a given entity token and then added to configuration.
    /// Derived class should have a public static "Create" method that creates instances of a class from entity tokens (see the example).
    /// </summary>
    /// <example>
    /// [PCCategory("xxxxxxx")]
    /// internal class PCDirectory : BasePackItem
    /// {
    ///   // ..
    ///   public static IEnumerable&lt;IPackItem&gt; Create(EntityToken entityToken)
    ///   {
    ///       if (entityToken is xxxxEntityToken) { .... }
    ///   }
    /// }
    /// </example>
    public interface IPackItem
    {
        string Id
        {
            get;
        }

        string ActionLabel
        {
            get;
        }

        string ActionToolTip
        {
            get;
        }

        ResourceHandle ActionIcon
        {
            get;
        }

        /// <summary>
        /// Icon that is used for showing the package creator item in 'Package Creator' perspective
        /// </summary>
        ResourceHandle ItemIcon
        {
            get;
        }

        string CategoryName { get; }

        string[] CategoryAllNames { get; }

        /// <summary>
        /// Gets the label for console action.
        /// </summary>
        /// <returns></returns>
        string GetLabel();

        /// <summary>
        /// Adds the package creator item to configuration.
        /// </summary>
        /// <param name="config">The config.</param>
        void AddToConfiguration(XElement config);

        /// <summary>
        /// Removes the package creator item from configuration.
        /// </summary>
        /// <param name="config">The config.</param>
        void RemoveFromConfiguration(XElement config);
    }
}
